/*
 * Copyright 2019 Rundeck, Inc. (http://rundeck.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.dtolabs.rundeck.core.utils;

/**
 * Buffer for capturing data into another data type
 *
 * @param <D> data type
 */
public interface LogBuffer<D> {
    /**
     * @return true if empty
     */
    boolean isEmpty();

    /**
     * reset buffer
     */
    void reset();

    /**
     * write a byte
     *
     * @param b data
     */
    void write(byte b);

    /**
     * Clear the buffer
     */
    void clear();

    /**
     * @return result datatype
     */
    D get();
}
